<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>tango.io.stream.UtfStream</title>
  <link href="./css/style.css" rel="stylesheet" type="text/css"/>
  <!-- <link href="./img/icon.png" rel="icon" type="image/png"/> -->
  <script type="text/javascript" src="./js/jquery.js"></script>
  <script type="text/javascript" src="./js/modules.js"></script>
  <script type="text/javascript" src="./js/quicksearch.js"></script>
  <script type="text/javascript" src="./js/navigation.js"></script>
  <!--<script type="text/javascript" src="./js/jquery.treeview.js"></script>-->
  <script type="text/javascript">
    var g_moduleFQN = "tango.io.stream.UtfStream";
  </script>
  
</head>
<body>
<div id="content">
  <h1><a href="./htmlsrc/tango.io.stream.UtfStream.html" class="symbol">tango.io.stream.UtfStream</a></h1>
  
<p class="sec_header">License:</p>BSD style: see <a href="http://www.dsource.org/projects/tango/wiki/LibraryLicense">license.txt</a>
<p class="sec_header">Version:</p>Initial release: Nov 2007
<p class="sec_header">Author:</p>Kris
<p class="bl"/>
        UTF conversion streams, supporting cross-translation of char, wchar 
        and dchar variants. For supporting endian variations, configure the
        appropriate EndianStream upstream of this one (closer to the source)
<dl>
<dt class="decl">class <a class="symbol _class" name="UtfInput" href="./htmlsrc/tango.io.stream.UtfStream.html#L31" kind="class" beg="31" end="89">UtfInput</a><span class="tparams">(T, S)</span> : InputFilter; <a title="Permalink to this symbol" href="#UtfInput" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.stream.UtfStream.html#L31">#</a></dt>
<dd class="ddef">
<div class="summary">Streaming UTF converter. Type T is the target or destination type, 
        while S is the source type. Both types are either char/wchar/dchar.</div>
<dl>
<dt class="decl"><a class="symbol _ctor" name="UtfInput.this" href="./htmlsrc/tango.io.stream.UtfStream.html#L45" kind="ctor" beg="45" end="48">this</a><span class="params">(InputStream <em>stream</em>)</span>; <a title="Permalink to this symbol" href="#UtfInput.this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.stream.UtfStream.html#L45">#</a></dt>
<dd class="ddef">
<div class="summary"></div></dd>
<dt class="decl">uint <a class="symbol _function" name="UtfInput.read" href="./htmlsrc/tango.io.stream.UtfStream.html#L54" kind="function" beg="54" end="88">read</a><span class="params">(void[] <em>dst</em>)</span>; <span class="attrs">[<span class="stc">override</span>, <span class="stc">final</span>]</span> <a title="Permalink to this symbol" href="#UtfInput.read" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.stream.UtfStream.html#L54">#</a></dt>
<dd class="ddef">
<div class="summary"></div></dd></dl></dd>
<dt class="decl">class <a class="symbol _class" name="UtfOutput" href="./htmlsrc/tango.io.stream.UtfStream.html#L101" kind="class" beg="101" end="178">UtfOutput</a><span class="tparams">(S, T)</span> : OutputFilter; <a title="Permalink to this symbol" href="#UtfOutput" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.stream.UtfStream.html#L101">#</a></dt>
<dd class="ddef">
<div class="summary">Streaming UTF converter. Type T is the target or destination type, 
        while S is the source type. Both types are either char/wchar/dchar.</div>
Note that the arguments are reversed from those of UtfInput
<dl>
<dt class="decl"><a class="symbol _ctor" name="UtfOutput.this" href="./htmlsrc/tango.io.stream.UtfStream.html#L116" kind="ctor" beg="116" end="120">this</a><span class="params">(OutputStream <em>stream</em>)</span>; <a title="Permalink to this symbol" href="#UtfOutput.this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.stream.UtfStream.html#L116">#</a></dt>
<dd class="ddef">
<div class="summary"></div></dd>
<dt class="decl">uint <a class="symbol _function" name="UtfOutput.write" href="./htmlsrc/tango.io.stream.UtfStream.html#L134" kind="function" beg="134" end="177">write</a><span class="params">(void[] <em>src</em>)</span>; <span class="attrs">[<span class="stc">override</span>, <span class="stc">final</span>]</span> <a title="Permalink to this symbol" href="#UtfOutput.write" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.io.stream.UtfStream.html#L134">#</a></dt>
<dd class="ddef">
<div class="summary">Write to the output stream from a source array. The provided 
                src content is converted as necessary. Note that an attached
                output buffer must be at least four bytes wide to accommodate
                a conversion.</div>
Returns the number of bytes consumed from src, which may be
                less than the quantity provided</dd></dl></dd></dl>
</div>
<div id="footer">
  <p>Copyright (c) 2007 Kris Bell. All rights reserved</p>
  <p>Page generated by <a href="http://code.google.com/p/dil">dil</a> on Fri Dec 26 04:04:01 2008. Rendered by <a href="http://code.google.com/p/dil/wiki/Kandil">kandil</a>.</p>
</div>
</body>
</html>